Loading TOC...

GET /manage/v2/databases/{id|name}/flexrep/pulls/{id|name}/properties

Summary

This resource address returns the flexible replication pull configuration properties for the database.

URL Parameters
format The format of the returned data. Can be either json or xml (default). This value overrides the Accept header if both are present.
Request Headers
Accept The expected MIME type of the response. If the format parameter is present, it takes precedence over the Accept header.
Content-type The MIME type of the data in the response body. Depending upon the value of the format parameter or Accept header, one of application/xml, application/json, or text/html.
Response Headers
Content-type The MIME type of the data in the response body. Depending upon the value of the format parameter or Accept header, one of application/xml, application/json, or text/html.

Response

Upon success, MarkLogic Server returns status code 200 (OK), and the response body contains the requested data. If the URI is malformed or the database does not exist, a status code of 400 (Bad Request) is returned. A status code of 401 (Unauthorized) is returned if the user does not have the necessary privileges.

Required Privileges

This operation requires the manage-user role, or the following privilege:

http://marklogic.com/xdmp/privileges/manage

Usage Notes

The structure of the output returned from this REST API is as follows:

pull-name

A name for replication target.

domain-id

The domain id.

target-id

The target id.

enabled

Whether or not this target is enabled. If the target is disabled, no attempt will be made to push replications.

urls

One or more URLs for master application servers.

This is a complex structure with the following children:

url

http-options

The HTTP options to use when connecting to the replication application server.

This is a complex structure with the following children:

method

The method to use.

username

password

client-cert

client-key

client-pass-phrase

credential-id

The credential id.

verify-cert

Whether the server's certificate should be verified.

proxy

The network location of the proxy server.

kerberos-ticket-forwarding

The option for kerberos ticket forwarding. If it is "disabled", the user ticket is not used. This is the default. If it is "required", the user ticket is forwarded. If the user ticket is not forwardable, XDMP-NOFORWARDTICKET is thrown. If it is "optional", the user ticket is forwarded if it is forwardable. But no error if it is not forwardable.

Example


http://localhost:8002/manage/v2/databases/Documents/flexrep/pulls/myPullConfig/properties

==> Returns the flexible replication pull properties for the configuration, 
   "myPullConfig," for the Documents database.

Stack Overflow iconStack Overflow: Get the most useful answers to questions from the MarkLogic community, or ask your own question.